<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: net_flow/endpoint.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">endpoint.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="endpoint_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#include &quot;<a class="code" href="endpoint_8hpp.html">flow/net_flow/endpoint.hpp</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a575cefcce9e8b34d6ea1420d6f6756d4">   24</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a575cefcce9e8b34d6ea1420d6f6756d4">Remote_endpoint::hash</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>  <span class="keyword">using </span>boost::hash_combine;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>  <span class="keyword">using </span>boost::hash_range;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>  <span class="keyword">using </span>boost::asio::ip::address;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>  <span class="keywordtype">size_t</span> val = 0;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>  <span class="comment">// Hash Flow port.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>  hash_combine(val, <a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#af96c7f45af596bde503059b4f84fc6ad">m_flow_port</a>);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>  <span class="comment">// Combine with hash of m_udp_endpoint.  Port is straightforward.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>  hash_combine(val, <a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a582f3a55d828cd4e36369682315c7629">m_udp_endpoint</a>.port());</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>  <span class="comment">/* @todo The following is kind of slow... lots of copies....  Maybe just use the above and allow</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment">   * for some hash collisions?  Or just use std::set/map instead of hash sets/maps? */</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <span class="comment">/* Hashing the address is trickier.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment">   * Could just hash to_string(), but seems slicker/faster to use the byte representation itself. */</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="keyword">const</span> address&amp; addr = <a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a582f3a55d828cd4e36369682315c7629">m_udp_endpoint</a>.address();</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>  <span class="keywordflow">if</span> (addr.is_v4())</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>  {</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <span class="comment">// Host byte order, but that&#39;s cool, as the hash value is computed and used only on this machine.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    hash_combine(val, addr.to_v4().to_uint());</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (addr.is_v6())</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>  {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    <span class="comment">// Network byte order.  Hash each byte of this byte array.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>    <span class="keyword">const</span> util::Ip_address_v6::bytes_type&amp; addr_bytes = addr.to_v6().to_bytes();</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>    hash_range(val, addr_bytes.begin(), addr_bytes.end());</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>  }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span>  <span class="comment">// else they&#39;ve invented another IP version... so we&#39;ll just have to deal with some hash collisions.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>  <span class="keywordflow">return</span> val;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>} <span class="comment">// Remote_endpoint::hash()</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a8504aeca20f41a8f2b98ae04803a600e">   60</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="namespaceflow_1_1net__flow.html#a8504aeca20f41a8f2b98ae04803a600e">operator==</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; lhs, <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; rhs)</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>{</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>  <span class="keywordflow">return</span> (lhs.<a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#af96c7f45af596bde503059b4f84fc6ad">m_flow_port</a> == rhs.<a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#af96c7f45af596bde503059b4f84fc6ad">m_flow_port</a>) &amp;&amp; (lhs.<a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a582f3a55d828cd4e36369682315c7629">m_udp_endpoint</a> == rhs.<a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a582f3a55d828cd4e36369682315c7629">m_udp_endpoint</a>);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>}</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a84e207ad5dc52f3832b5a5f73c75e11e">   65</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; endpoint)</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>{</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>  <span class="keywordflow">return</span> os &lt;&lt; <span class="stringliteral">&quot;NetFlow [UDP &quot;</span> &lt;&lt; endpoint.<a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a582f3a55d828cd4e36369682315c7629">m_udp_endpoint</a> &lt;&lt; <span class="stringliteral">&quot;]:&quot;</span> &lt;&lt; endpoint.<a class="code hl_variable" href="structflow_1_1net__flow_1_1Remote__endpoint.html#af96c7f45af596bde503059b4f84fc6ad">m_flow_port</a>;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>}</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structflow_1_1net__flow_1_1Remote__endpoint.html#ab38246018ee64662d208371c55ffb1bd">   70</a></span><span class="keywordtype">size_t</span> <a class="code hl_function" href="namespaceflow_1_1net__flow.html#a152200ba9432e5ca229e41a1c5d9d226">hash_value</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; remote_endpoint)</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>{</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>  <span class="keywordflow">return</span> remote_endpoint.<a class="code hl_function" href="structflow_1_1net__flow_1_1Remote__endpoint.html#a575cefcce9e8b34d6ea1420d6f6756d4">hash</a>();</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>}</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>} <span class="comment">// namespace flow::net_flow</span></div>
<div class="ttc" id="aendpoint_8hpp_html"><div class="ttname"><a href="endpoint_8hpp.html">endpoint.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html"><div class="ttname"><a href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div><div class="ttdoc">Flow module containing the API and implementation of the Flow network protocol, a TCP-inspired stream...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_a152200ba9432e5ca229e41a1c5d9d226"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#a152200ba9432e5ca229e41a1c5d9d226">flow::net_flow::hash_value</a></div><div class="ttdeci">size_t hash_value(const Sequence_number &amp;seq_num)</div><div class="ttdoc">Free function that returns seq_num.hash(); has to be a free function named hash_value for boost....</div><div class="ttdef"><b>Definition:</b> <a href="seq__num_8cpp_source.html#l00275">seq_num.cpp:275</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_a8504aeca20f41a8f2b98ae04803a600e"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#a8504aeca20f41a8f2b98ae04803a600e">flow::net_flow::operator==</a></div><div class="ttdeci">bool operator==(const Remote_endpoint &amp;lhs, const Remote_endpoint &amp;rhs)</div><div class="ttdoc">Whether lhs is equal to rhs.</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8cpp_source.html#l00060">endpoint.cpp:60</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_ab9f537c84f77e9b8fa742fc5dc6d5693"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">flow::net_flow::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Congestion_control_selector::Strategy_choice &amp;strategy_choice)</div><div class="ttdoc">Serializes a Peer_socket_options::Congestion_control_strategy_choice enum to a standard ostream – the...</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl_8cpp_source.html#l00146">cong_ctl.cpp:146</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Remote__endpoint_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Remote__endpoint.html">flow::net_flow::Remote_endpoint</a></div><div class="ttdoc">Represents the remote endpoint of a Flow-protocol connection; identifies the UDP endpoint of the remo...</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8hpp_source.html#l00092">endpoint.hpp:93</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Remote__endpoint_html_a575cefcce9e8b34d6ea1420d6f6756d4"><div class="ttname"><a href="structflow_1_1net__flow_1_1Remote__endpoint.html#a575cefcce9e8b34d6ea1420d6f6756d4">flow::net_flow::Remote_endpoint::hash</a></div><div class="ttdeci">size_t hash() const</div><div class="ttdoc">Hash value of this Remote_endpoint for unordered_*&lt;&gt;.</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8cpp_source.html#l00024">endpoint.cpp:24</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Remote__endpoint_html_a582f3a55d828cd4e36369682315c7629"><div class="ttname"><a href="structflow_1_1net__flow_1_1Remote__endpoint.html#a582f3a55d828cd4e36369682315c7629">flow::net_flow::Remote_endpoint::m_udp_endpoint</a></div><div class="ttdeci">util::Udp_endpoint m_udp_endpoint</div><div class="ttdoc">UDP address (IP address/UDP port) where the Node identified by this endpoint bound its low-level UDP ...</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8hpp_source.html#l00097">endpoint.hpp:97</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Remote__endpoint_html_af96c7f45af596bde503059b4f84fc6ad"><div class="ttname"><a href="structflow_1_1net__flow_1_1Remote__endpoint.html#af96c7f45af596bde503059b4f84fc6ad">flow::net_flow::Remote_endpoint::m_flow_port</a></div><div class="ttdeci">flow_port_t m_flow_port</div><div class="ttdoc">The logical Flow port within the Node for the particular connection identified by this endpoint.</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8hpp_source.html#l00099">endpoint.hpp:99</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
